
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>How To Validate a New Release &mdash; LLVM 3.7 documentation</title>
    
    <link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '3.7',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="LLVM 3.7 documentation" href="index.html" />
    <link rel="next" title="Code Reviews with Phabricator" href="Phabricator.html" />
    <link rel="prev" title="Advice on Packaging LLVM" href="Packaging.html" />
<style type="text/css">
  table.right { float: right; margin-left: 20px; }
  table.right td { border: 1px solid #ccc; }
</style>

  </head>
  <body role="document">
<div class="logo">
  <a href="index.html">
    <img src="_static/logo.png"
         alt="LLVM Logo" width="250" height="88"/></a>
</div>

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="Phabricator.html" title="Code Reviews with Phabricator"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="Packaging.html" title="Advice on Packaging LLVM"
             accesskey="P">previous</a> |</li>
  <li><a href="http://llvm.org/">LLVM Home</a>&nbsp;|&nbsp;</li>
  <li><a href="index.html">Documentation</a>&raquo;</li>
 
      </ul>
    </div>


    <div class="document">
      <div class="documentwrapper">
          <div class="body" role="main">
            
  <div class="section" id="how-to-validate-a-new-release">
<h1>How To Validate a New Release<a class="headerlink" href="#how-to-validate-a-new-release" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id9">Introduction</a></li>
<li><a class="reference internal" href="#scripts" id="id10">Scripts</a></li>
<li><a class="reference internal" href="#test-suite" id="id11">Test Suite</a></li>
<li><a class="reference internal" href="#pre-release-process" id="id12">Pre-Release Process</a></li>
<li><a class="reference internal" href="#release-process" id="id13">Release Process</a></li>
<li><a class="reference internal" href="#bug-reporting-process" id="id14">Bug Reporting Process</a></li>
</ul>
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id9">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>This document contains information about testing the release candidates that will
ultimately be the next LLVM release. For more information on how to manage the
actual release, please refer to <a class="reference internal" href="HowToReleaseLLVM.html"><em>How To Release LLVM To The Public</em></a>.</p>
<div class="section" id="overview-of-the-release-process">
<h3>Overview of the Release Process<a class="headerlink" href="#overview-of-the-release-process" title="Permalink to this headline">¶</a></h3>
<p>Once the release process starts, the Release Manager will ask for volunteers,
and it&#8217;ll be the role of each volunteer to:</p>
<ul class="simple">
<li>Test and benchmark the previous release</li>
<li>Test and benchmark each release candidate, comparing to the previous release and candidates</li>
<li>Identify, reduce and report every regression found during tests and benchmarks</li>
<li>Make sure the critical bugs get fixed and merged to the next release candidate</li>
</ul>
<p>Not all bugs or regressions are show-stoppers and it&#8217;s a bit of a grey area what
should be fixed before the next candidate and what can wait until the next release.</p>
<p>It&#8217;ll depend on:</p>
<ul class="simple">
<li>The severity of the bug, how many people it affects and if it&#8217;s a regression or a
known bug. Known bugs are &#8220;unsupported features&#8221; and some bugs can be disabled if
they have been implemented recently.</li>
<li>The stage in the release. Less critical bugs should be considered to be fixed between
RC1 and RC2, but not so much at the end of it.</li>
<li>If it&#8217;s a correctness or a performance regression. Performance regression tends to be
taken more lightly than correctness.</li>
</ul>
</div>
</div>
<div class="section" id="scripts">
<span id="id1"></span><h2><a class="toc-backref" href="#id10">Scripts</a><a class="headerlink" href="#scripts" title="Permalink to this headline">¶</a></h2>
<p>The scripts are in the <code class="docutils literal"><span class="pre">utils/release</span></code> directory.</p>
<div class="section" id="test-release-sh">
<h3>test-release.sh<a class="headerlink" href="#test-release-sh" title="Permalink to this headline">¶</a></h3>
<p>This script will check-out, configure and compile LLVM+Clang (+ most add-ons, like <code class="docutils literal"><span class="pre">compiler-rt</span></code>,
<code class="docutils literal"><span class="pre">libcxx</span></code> and <code class="docutils literal"><span class="pre">clang-extra-tools</span></code>) in three stages, and will test the final stage.
It&#8217;ll have installed the final binaries on the Phase3/Releasei(+Asserts) directory, and
that&#8217;s the one you should use for the test-suite and other external tests.</p>
<p>To run the script on a specific release candidate run:</p>
<div class="highlight-python"><div class="highlight"><pre>./test-release.sh \
     -release 3.3 \
     -rc 1 \
     -no-64bit \
     -test-asserts \
     -no-compare-files
</pre></div>
</div>
<p>Each system will require different options. For instance, x86_64 will obviously not need
<code class="docutils literal"><span class="pre">-no-64bit</span></code> while 32-bit systems will, or the script will fail.</p>
<p>The important flags to get right are:</p>
<ul class="simple">
<li>On the pre-release, you should change <code class="docutils literal"><span class="pre">-rc</span> <span class="pre">1</span></code> to <code class="docutils literal"><span class="pre">-final</span></code>. On RC2, change it to <code class="docutils literal"><span class="pre">-rc</span> <span class="pre">2</span></code> and so on.</li>
<li>On non-release testing, you can use <code class="docutils literal"><span class="pre">-final</span></code> in conjunction with <code class="docutils literal"><span class="pre">-no-checkout</span></code>, but you&#8217;ll have to
create the <code class="docutils literal"><span class="pre">final</span></code> directory by hand and link the correct source dir to <code class="docutils literal"><span class="pre">final/llvm.src</span></code>.</li>
<li>For release candidates, you need <code class="docutils literal"><span class="pre">-test-asserts</span></code>, or it won&#8217;t create a &#8220;Release+Asserts&#8221; directory,
which is needed for release testing and benchmarking. This will take twice as long.</li>
<li>On the final candidate you just need Release builds, and that&#8217;s the binary directory you&#8217;ll have to pack.</li>
</ul>
<p>This script builds three phases of Clang+LLVM twice each (Release and Release+Asserts), so use
screen or nohup to avoid headaches, since it&#8217;ll take a long time.</p>
<p>Use the <code class="docutils literal"><span class="pre">--help</span></code> option to see all the options and chose it according to your needs.</p>
</div>
<div class="section" id="findregressions-nightly-py">
<h3>findRegressions-nightly.py<a class="headerlink" href="#findregressions-nightly-py" title="Permalink to this headline">¶</a></h3>
<p>TODO</p>
</div>
</div>
<div class="section" id="test-suite">
<span id="id2"></span><h2><a class="toc-backref" href="#id11">Test Suite</a><a class="headerlink" href="#test-suite" title="Permalink to this headline">¶</a></h2>
<p>Follow the <a class="reference external" href="http://llvm.org/docs/lnt/quickstart.html">LNT Quick Start Guide</a> link on how to set-up the test-suite</p>
<p>The binary location you&#8217;ll have to use for testing is inside the <code class="docutils literal"><span class="pre">rcN/Phase3/Release+Asserts/llvmCore-REL-RC.install</span></code>.
Link that directory to an easier location and run the test-suite.</p>
<p>An example on the run command line, assuming you created a link from the correct
install directory to <code class="docutils literal"><span class="pre">~/devel/llvm/install</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>./sandbox/bin/python sandbox/bin/lnt runtest \
    nt \
    -j4 \
    --sandbox sandbox \
    --test-suite ~/devel/llvm/test/test-suite \
    --cc ~/devel/llvm/install/bin/clang \
    --cxx ~/devel/llvm/install/bin/clang++
</pre></div>
</div>
<p>It should have no new regressions, compared to the previous release or release candidate. You don&#8217;t need to fix
all the bugs in the test-suite, since they&#8217;re not necessarily meant to pass on all architectures all the time. This is
due to the nature of the result checking, which relies on direct comparison, and most of the time, the failures are
related to bad output checking, rather than bad code generation.</p>
<p>If the errors are in LLVM itself, please report every single regression found as blocker, and all the other bugs
as important, but not necessarily blocking the release to proceed. They can be set as &#8220;known failures&#8221; and to be
fix on a future date.</p>
</div>
<div class="section" id="pre-release-process">
<span id="id4"></span><h2><a class="toc-backref" href="#id12">Pre-Release Process</a><a class="headerlink" href="#pre-release-process" title="Permalink to this headline">¶</a></h2>
<p>When the release process is announced on the mailing list, you should prepare
for the testing, by applying the same testing you&#8217;ll do on the release candidates,
on the previous release.</p>
<p>You should:</p>
<ul class="simple">
<li>Download the previous release sources from <a class="reference external" href="http://llvm.org/releases/download.html">http://llvm.org/releases/download.html</a>.</li>
<li>Run the test-release.sh script on <code class="docutils literal"><span class="pre">final</span></code> mode (change <code class="docutils literal"><span class="pre">-rc</span> <span class="pre">1</span></code> to <code class="docutils literal"><span class="pre">-final</span></code>).</li>
<li>Once all three stages are done, it&#8217;ll test the final stage.</li>
<li>Using the <code class="docutils literal"><span class="pre">Phase3/Release+Asserts/llvmCore-MAJ.MIN-final.install</span></code> base, run the test-suite.</li>
</ul>
<p>If the final phase&#8217;s <code class="docutils literal"><span class="pre">make</span> <span class="pre">check-all</span></code> failed, it&#8217;s a good idea to also test the
intermediate stages by going on the obj directory and running <code class="docutils literal"><span class="pre">make</span> <span class="pre">check-all</span></code> to find
if there&#8217;s at least one stage that passes (helps when reducing the error for bug report
purposes).</p>
</div>
<div class="section" id="release-process">
<span id="id6"></span><h2><a class="toc-backref" href="#id13">Release Process</a><a class="headerlink" href="#release-process" title="Permalink to this headline">¶</a></h2>
<p>When the Release Manager sends you the release candidate, download all sources,
unzip on the same directory (there will be sym-links from the appropriate places
to them), and run the release test as above.</p>
<p>You should:</p>
<ul class="simple">
<li>Download the current candidate sources from where the release manager points you
(ex. <a class="reference external" href="http://llvm.org/pre-releases/3.3/rc1/">http://llvm.org/pre-releases/3.3/rc1/</a>).</li>
<li>Repeat the steps above with <code class="docutils literal"><span class="pre">-rc</span> <span class="pre">1</span></code>, <code class="docutils literal"><span class="pre">-rc</span> <span class="pre">2</span></code> etc modes and run the test-suite
the same way.</li>
<li>Compare the results, report all errors on Bugzilla and publish the binary blob
where the release manager can grab it.</li>
</ul>
<p>Once the release manages announces that the latest candidate is the good one, you
have to pack the <code class="docutils literal"><span class="pre">Release</span></code> (no Asserts) install directory on <code class="docutils literal"><span class="pre">Phase3</span></code> and that
will be the official binary.</p>
<ul class="simple">
<li>Rename (or link) <code class="docutils literal"><span class="pre">clang+llvm-REL-ARCH-ENV</span></code> to the .install directory</li>
<li>Tar that into the same name with <code class="docutils literal"><span class="pre">.tar.gz</span></code> extensioan from outside the directory</li>
<li>Make it available for the release manager to download</li>
</ul>
</div>
<div class="section" id="bug-reporting-process">
<span id="bug-reporting"></span><h2><a class="toc-backref" href="#id14">Bug Reporting Process</a><a class="headerlink" href="#bug-reporting-process" title="Permalink to this headline">¶</a></h2>
<p>If you found regressions or failures when comparing a release candidate with the
previous release, follow the rules below:</p>
<ul class="simple">
<li>Critical bugs on compilation should be fixed as soon as possible, possibly before
releasing the binary blobs.</li>
<li>Check-all tests should be fixed before the next release candidate, but can wait
until the test-suite run is finished.</li>
<li>Bugs in the test suite or unimportant check-all tests can be fixed in between
release candidates.</li>
<li>New features or recent big changes, when close to the release, should have done
in a way that it&#8217;s easy to disable. If they misbehave, prefer disabling them than
releasing an unstable (but untested) binary package.</li>
</ul>
</div>
</div>


          </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="Phabricator.html" title="Code Reviews with Phabricator"
             >next</a> |</li>
        <li class="right" >
          <a href="Packaging.html" title="Advice on Packaging LLVM"
             >previous</a> |</li>
  <li><a href="http://llvm.org/">LLVM Home</a>&nbsp;|&nbsp;</li>
  <li><a href="index.html">Documentation</a>&raquo;</li>
 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright 2003-2015, LLVM Project.
      Last updated on 2015-09-08.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
    </div>
  </body>
</html>